home *** CD-ROM | disk | FTP | other *** search
/ LOGIC Apps / Logic-APPLE_II_APPS.iso / mac / LOGIC Apple II 5.25" Library - ProDOS / PRO086B.dsk / SYSOP.DOC.txt < prev    next >
Text File  |  2012-02-16  |  10KB  |  242 lines
  1. * Warp Six BBS Sysop Documentation *
  2.  
  3. Updated September 4, 1989
  4.  
  5. Copyright 1986-1989 Jim Ferr
  6.  
  7. All rights reserved except as noted in READ.ME.FIRST.
  8.  
  9. Welcome to your new system. This file will give you a quick overview of the
  10. BBS, and its functions.
  11.  
  12. Contents
  13. --------
  14.  
  15. Setting up directories
  16. Making Changes
  17. Adding/changing General files and Help files
  18. Adding forums
  19. Uploading Text Files
  20. Changing New User Routines
  21. Maintaining the USERS file
  22. Doing the system news
  23. General Hints
  24.  
  25.  
  26. Setting up Directories
  27.  
  28. As you know, ProDOS volumes allow the use of extensive subdirectories. One note
  29. of trivia you may not know is that the main directory on any ProDOS volume is
  30. limited to 51 files. Therefore it makes sense to have the system divided into
  31. subdirectories, where there is no 51 file limitation.
  32.  
  33. There are three configurable areas:
  34.  
  35. 1) The main, or root directory for the BBS which holds programs and text files
  36. 2) The Email root directory (the directory in which the subdir EMAIL is found)
  37. 3) The Forums root directory (the directory in which the FORUM.n subdirs are
  38.    found)
  39.  
  40. All three can reside on the different ProDOS volumes if you wish, or on the
  41. same volume, in any combination. As supplied, the system is set up like so:
  42.  
  43. Root directory: /W6/WARP6         (held in RT$)
  44.  
  45. Email root directory: /W6/WARP6   (held in EP$)
  46.  
  47. Forums root directory /W6/WARP6   (held in FP$)
  48.  
  49. These strings are the first three lines of the SYS.DATA file. Here is a
  50. complete definition of that file:
  51.  
  52. SYS.DATA, type TXT
  53.  
  54. RT$   Root Pathname for system
  55. FP$   Forum dir pathname
  56. EP$   Email dir pathname
  57. SN$   System Name
  58. SP$   Copyright message
  59. RP$   Remote (Sysop) Password
  60. HR$   Hours/baud rate message
  61. AB$   abort string (Control-S to pause...)
  62. CS    Clock slot
  63. FC    Forum Count: total # of forums
  64. CD$   Current date in ProDOS format
  65. CT    Call Total for System
  66.  
  67. When making changes to this file, ensure you do not add any separators
  68. to any of the fields, ie. do NOT add any COMMAS or COLONS.
  69.  
  70. RT$ defines the Root directory, which holds all the system program files and
  71. menus, as well as the GEN subdirectory and the HELP subdirectory.
  72.  
  73. FP$ tells the system where the Forums root directory is. Forums are kept in
  74. subdirectories called FORUM.1, FORUM.2, FORUM.3, and so on.
  75.  
  76. EP$ defines the Email Root directory, where the EMAIL subdirectory will
  77. reside.
  78.  
  79. To illustrate further, if the BBS programs and menus are in the directory,
  80. /PROFILE/BBS, then RT$ must be "/PROFILE/BBS" (without the quotes). If you
  81. want Email to reside in /EXTRA/EMAIL, then EP$ must be "/EXTRA". Note the
  82. difference: with the Email and forums directories, the system adds the final
  83. directory name for you.
  84.  
  85.  
  86. Making Changes
  87.  
  88. The following paragraphs describe the functions of many files on the system. To
  89. make changes to the files, you need to use a text based word processor like
  90. Apple Writer //. The program must allow saving of files in ASCII format (high
  91. bit clear) and musn't imbed any unwanted control characters. When making file
  92. changes, refer to Warp6.Doc for field definitions and names.
  93.  
  94. For instance, you will probably want to give your system a unique name. Change
  95. the appropriate line in the SYS.DATA file, making sure you add no commas or
  96. colons. (See Warp6.Doc for field descriptions.)
  97.  
  98.  
  99. Adding/Changing General and Help Files
  100.  
  101. As mentioned, the general and help files are kept in the Root directory for the
  102. system under the GEN and HELP directories. The Help file section is only one
  103. level deep, while the General file section is two levels deep:
  104.  
  105. HELP-----F.DATA (holds number of help files)
  106.          TITLES
  107.          F1
  108.          F2
  109.          and so on for each help file.
  110.  
  111. GEN------F.DATA (holds number of subsections)
  112.          TITLES (subsection menu)
  113.          F1-------F.DATA (holds number of files in this section)
  114.                   TITLES (menu of files in this section)
  115.                   F1
  116.                   F2
  117.                   and so on for each Gen file
  118.          F2-------F.DATA
  119.                   TITLES
  120.                   F1
  121.                   etc.
  122.  
  123. The F.DATA file holds FM$, which holds the file section or subsection name, as
  124. well as TT, the total number of files (or subsections). Nesting only occurs in
  125. the GEN diretory, and only one level deep. The TITLES file holds the menu of
  126. the files or subsections. The files or subsections are named F1, F2 and so on.
  127. Files are always text files, subsections are always directories.
  128.  
  129. To mount a new file, increment TT in the F.DATA file by one, and add the name
  130. of the file to the TITLES menu. Then save the file under the appropriate file
  131. name; F5 for example, if it will be the fifth file in the TITLES menu.
  132.  
  133. To mount a new section, increment TT in the GEN/F.DATA file and add the section
  134. name to the GEN/TITLES file. Then create the section directory, Fn, where 'n'
  135. is the section number, and create an F.DATA and TITLES file in that directory,
  136. holding the section name, number of files, and menu.
  137.  
  138. Adding Forums to the System
  139.  
  140. Adding forums is easy, because the process is menu driven. Choose A)dd a forum
  141. from the sysop utilties (accessable by entering * from the main command level).
  142. You will be prompted for the forum's name, eg. The Main Forum, the minimum
  143. security level required for entry (usually 2), and the minimum security level
  144. required to write bulletins (again, usually 2).
  145.  
  146. You will be asked to set the bulletin limit, which will determine how many
  147. bulletins can be posted before one is automatically deleted.* Then you will be
  148. asked which bulletin you'd like to be deleted when the limit is reached.
  149. Generally, you will set this to 1, so the system will delete the first bulletin
  150. on the forum. If the first bulletin on the forum contains a message you'd like
  151. to remain permanent, set it to 2. If there are a number of 'permanent'
  152. bulletins, set the first to delete to whatever you like.
  153.  
  154.   * Each forum can hold a maximum of 99 bulletins. Don't attempt to exceed
  155.     this number.
  156.  
  157. To disable automatic deletion of bulletins at the limit, enter a zero for the
  158. first to delete. When the forum reaches a total of 100 bulletins, users trying
  159. to post more will be informed the forum is full, and you'll have to delete
  160. bulletins manually to make room.
  161.  
  162. Forums contain a number of data files. The OPENER file is the opening message
  163. users see when entering the forum. (Note that they don't see this when using
  164. Quickscan.) The F.DATA file holds information about the forum, and the TITLES
  165. file holds the filenames and subjects of each bulletin posted. Finally, the
  166. U.DATA file keeps track of the highest bulletin number each user read last, for
  167. new, Quickscan and spool. See the file descriptions for more detail.
  168.  
  169. To delete a forum, you must remove it's menu item from the FORUM.NAMES file and
  170. delete all the files in the forum. Finally you have to rename any forums
  171. necessary so they are all in sequential order from FORUM.1 to FORUM.n, where n
  172. is your last remaining forum.
  173.  
  174. Uploading Text Files
  175.  
  176. As Sysop, you can upload to any ProDOS pathname that does not already exist.
  177. The U)pload a Text File command from the main menu accomplishes this. End
  178. users can also use the command, but their uploads are restricted to the
  179. UPLOADS directory and always end with the suffix ".1000" where 1000 is the
  180. user ID number of the uploader. End users can't enter slashes or full
  181. pathnames; only the Sysop can. Note: to append or overwrite an existing text
  182. file (sysop only), use the C)reate text file option in Sys.Utils.
  183.  
  184. Changing new user routines
  185.  
  186. Currently the system will take a new user application and assign that user
  187. level 0, unvalidated status. The new user does not get access to the BBS until
  188. you have validated them with a phone call. (You can easily change this in
  189. the Add.User program.)
  190.  
  191. Maintaining the USERS file
  192.  
  193. The USERS file maintains itself, actually, but you need to help out a bit, by
  194. validating new users, deleting stale ID's, and editing user ID's when people
  195. need to be promoted, or change their city or phone number. It's all done
  196. from the Sysop.Util program, accessible from the main command level by typing
  197. an asterisk. The User purge function is particularly useful, allowing you to
  198. delete both new users you haven't validated up to a cutoff date of your own
  199. choosing, and stale users that haven't called after a selectable cutoff date.
  200. Use the prompt for deletions option to ensure you don't delete someone you
  201. don't want to by mistake, and make a backup of your USERS and REC.DATA files
  202. before running the User Purge function.
  203.  
  204. Doing the System News
  205.  
  206. The opening message for the BBS is held in the file 'SYS.NEWS', and can be
  207. updated directly from the Sysop Utilities by choosing the C)reate text file
  208. option and saving to SYS.NEWS. When saving a file you have two options,
  209. E)rase and write, which will delete any existing file with the name you
  210. chose, and A)ppend, which will add to an existing file or will create a
  211. new file if the file does not exist.
  212.  
  213. General Hints
  214.  
  215. The security level system is flexible, and has proven more than enough for
  216. normal uses. Level 0 is unvalidated, Level 1 is devalidated, and Level 2 is
  217. a normal user. Users must have level 2 access to upload text files. There is
  218. a "membership flag" which I use to distinguish users who made a financial
  219. or other contribution to the system. You can create forums that are
  220. restricted to users with the membership flag set. Both user security levels
  221. and all their other stats can be edited in the Sysop Utilities program.
  222.  
  223. The time limit calculation for all users is located in the LOGON program.
  224. You can, of course, change the method of calculation.
  225.  
  226. Another thing you can change is the Letter Limit assigned to all users, which
  227. governs the maximum number of letters they can have in their 'mailbox' at any
  228. one time. Just set the LL variable in line 35. The daily call limit per user
  229. (except the sysop) is held in the variable CL, set in the same area. The
  230. default is five calls per day.
  231.  
  232. The maximum number of lines in the editor is set around line 3000, in the
  233. program Warp6.BBS, in the variable ML. Don't change this higher than it's
  234. current value unless you want to witness a crash when the system runs
  235. out of memory...
  236.  
  237. Other things you can change include the menus, which are in text files for the
  238. most part, and some fields in the SYS.DATA file. Be careful not to include any
  239. characters Applesoft could interpret as separators or terminators in the
  240. various fields of the SYS.DATA file. I'm speaking of the dreaded comma and
  241. colon, of course.
  242.